Skip to main content

SetBackgroundColor

Sets the background color to all cells in the current table.

Syntax

expression.SetBackgroundColor(r, g, b, bNone);

expression - A variable that represents a ApiTable class.

Parameters

NameRequired/OptionalData typeDefaultDescription
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.
bNoneRequiredbooleanDefines that background color will not be set.

Returns

boolean

Example

This example sets the background color to all cells in the table.

let doc = Api.GetDocument();
let tableStyle = doc.CreateStyle("CustomTableStyle", "table");
tableStyle.SetBasedOn(doc.GetStyle("Bordered"));
let table = Api.CreateTable(4, 2);
table.SetWidth("percent", 100);
table.SetStyle(tableStyle);
table.SetBackgroundColor(255, 111, 61, false);
doc.Push(table);